<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Over The Air (OTA) Update Library: cy_ota_storage_write_info_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="infineon_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Over The Air (OTA) Update Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Home</span></a></li>
      <li><a href="modules.html"><span>API&#160;Reference</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structcy__ota__storage__write__info__t.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">cy_ota_storage_write_info_t Struct Reference<div class="ingroups"><a class="el" href="group__group__ota__structures.html">OTA Structures</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>Struct to hold information on where to write the data. </p>
<p>Information on where to store the downloaded chunk of the OTA image. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a23215e611d8933d75fc52e902d3f4502"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__write__info__t.html#a23215e611d8933d75fc52e902d3f4502">total_size</a></td></tr>
<tr class="memdesc:a23215e611d8933d75fc52e902d3f4502"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pass the total size to the storage module; 0 = disregard.  <a href="#a23215e611d8933d75fc52e902d3f4502">More...</a><br /></td></tr>
<tr class="separator:a23215e611d8933d75fc52e902d3f4502"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0405b3806c0de934f5f5f55ac693c184"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__write__info__t.html#a0405b3806c0de934f5f5f55ac693c184">offset</a></td></tr>
<tr class="memdesc:a0405b3806c0de934f5f5f55ac693c184"><td class="mdescLeft">&#160;</td><td class="mdescRight">Offset into file/area where the data belongs.  <a href="#a0405b3806c0de934f5f5f55ac693c184">More...</a><br /></td></tr>
<tr class="separator:a0405b3806c0de934f5f5f55ac693c184"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af66dba2bcbb117c85bcf20fa0357c525"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__write__info__t.html#af66dba2bcbb117c85bcf20fa0357c525">buffer</a></td></tr>
<tr class="memdesc:af66dba2bcbb117c85bcf20fa0357c525"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the buffer with the chunk of data.  <a href="#af66dba2bcbb117c85bcf20fa0357c525">More...</a><br /></td></tr>
<tr class="separator:af66dba2bcbb117c85bcf20fa0357c525"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20c92fe4a9bba891efd3319efbd05060"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__write__info__t.html#a20c92fe4a9bba891efd3319efbd05060">size</a></td></tr>
<tr class="memdesc:a20c92fe4a9bba891efd3319efbd05060"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the data in the buffer.  <a href="#a20c92fe4a9bba891efd3319efbd05060">More...</a><br /></td></tr>
<tr class="separator:a20c92fe4a9bba891efd3319efbd05060"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe05546ecff7e5985d268248c0ebb3e5"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__write__info__t.html#abe05546ecff7e5985d268248c0ebb3e5">packet_number</a></td></tr>
<tr class="memdesc:abe05546ecff7e5985d268248c0ebb3e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT: The packet number of this chunk.  <a href="#abe05546ecff7e5985d268248c0ebb3e5">More...</a><br /></td></tr>
<tr class="separator:abe05546ecff7e5985d268248c0ebb3e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d5cf26f262a52569a71a8948df60b56"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__write__info__t.html#a3d5cf26f262a52569a71a8948df60b56">total_packets</a></td></tr>
<tr class="memdesc:a3d5cf26f262a52569a71a8948df60b56"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT: Total packets (chunks) in the OTA image.  <a href="#a3d5cf26f262a52569a71a8948df60b56">More...</a><br /></td></tr>
<tr class="separator:a3d5cf26f262a52569a71a8948df60b56"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a23215e611d8933d75fc52e902d3f4502"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t cy_ota_storage_write_info_t::total_size</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pass the total size to the storage module; 0 = disregard. </p>

</div>
</div>
<a class="anchor" id="a0405b3806c0de934f5f5f55ac693c184"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t cy_ota_storage_write_info_t::offset</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Offset into file/area where the data belongs. </p>

</div>
</div>
<a class="anchor" id="af66dba2bcbb117c85bcf20fa0357c525"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t* cy_ota_storage_write_info_t::buffer</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pointer to the buffer with the chunk of data. </p>

</div>
</div>
<a class="anchor" id="a20c92fe4a9bba891efd3319efbd05060"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t cy_ota_storage_write_info_t::size</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Size of the data in the buffer. </p>

</div>
</div>
<a class="anchor" id="abe05546ecff7e5985d268248c0ebb3e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t cy_ota_storage_write_info_t::packet_number</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>MQTT: The packet number of this chunk. </p>

</div>
</div>
<a class="anchor" id="a3d5cf26f262a52569a71a8948df60b56"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t cy_ota_storage_write_info_t::total_packets</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>MQTT: Total packets (chunks) in the OTA image. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Over The Air (OTA) Update Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
